dxp-ux
Enable or Disable Autopay ( TMF -666 PATCH)
Request to enable or disable auto pay
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/billingAccount/{id}Base URI Parameter
URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (PR) identifying the business unit. | Y |
| id | string | Billing Account Number. | Y |
Headers
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications.Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request Pattern: ^[a-zA-Z0-9-+/=_]{16,64}$ Minimum characters: 16 Maximum characters: 64 | Y |
Request
curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/dxp-ux/dxp-ux/v1/PR/billingAccount/31516278-31514752' \
--header 'X-Correlation-ID: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2gk' \
--header 'client_id: abcd' \
--header 'client_secret: 12345' \
--header 'Content-Type: application/json' \
--data-raw '{
"defaultPaymentMethod": {
"@referredType": "Autopay",
"id": "PM-a6Idq00000005FpEAI"
},
"extendedCharacteristic": [
{
"value": "Digital",
"name": "sourceSystem"
},
{
"value": "true",
"name": "restrictOrder"
}
],
"relatedParty": [
{
"id": "12218008051",
"@type": "msisdn"
}
]
}'Definitions
| name | value (length) | description | required |
|---|---|---|---|
| defaultPaymentMethod | object | Details of payment method | Y |
| defaultPaymentMethod.@referredType | String | type of payment. Allowed Values To enable: Autopay To disable: Non-Autopay | Y |
| defaultPaymentMethod.id | String (30) | unique identifier of payment type | Y |
| extendedCharacteristic | Array | details of characteristic | Y |
| extendedCharacteristic.value | String | value of characteristic | Y* |
| extendedCharacteristic.name | String | name of characteristic | Y* |
| relatedParty | Array | details of relatedParty | N |
| relatedParty.id | String (20) | id of relatedParty, Mobile Device number | N |
| relatedParty.@type | String | type of relatedParty, expecting static value 'msisdn' | N |
extendedCharacteristic values
| name | value | description | required |
|---|---|---|---|
| sourceSystem | string (30) | Source System information for tracking purpose: possible value IVR/Digital | Y |
| restrictOrder | boolean | Restrict the order submission if it is call center flow | N |
[ 200 ]
OK - updateBillingAccount request processed successfully, response body contains an entity corresponding to the requested resource.
Response
{
"status": 200,
"description": "Autopay change request received"
}Definitions
| name | value | description | required |
|---|---|---|---|
| status | number | status code of the response | N |
| description | string | status description of the response | N |